Request For Payment Response
The RequestForPaymentResponse method enables to receive response for the Payment Request (RFP_OUT) initiated by the beneficiary
Method: InboundServiceClient:RequestForPaymentResponse
Headers
Name | Value |
---|---|
Credential | "Basic c3VwcG9ydCsxQG5ldHN5cy1pbmMuY29tOjM5ZDYxOGJkNTVmN5NWQxY2RlNDE5" |
Signature | "{{signature}}" |
Example
Payload Parameters
Parameter | Description |
---|---|
acceptedAmount (applicable only for FedNow) | Object |
amount Optional | Number Amount of transaction accepted by the sender Example – 222200 |
currency Optional | String Currency code in which the transaction happens Example – "USD" |
creditorAccount Mandatory | Object |
accountNumber Mandatory | String Account number of the beneficiary Example – "69988022968" |
memberId Mandatory | String Routing numer of the beneficiary bank/financial institution Example – "101110802" |
name Mandatory | String Name of the beneficiary Example – "William" |
debtorAccount Mandatory | Object |
accountNumber Mandatory | String Account number of the sender Example – "200105743028554" |
memberId Mandatory | String Routing numer of the sender bank/financial institution Example – "101115315" |
name Mandatory | String Name of the sender Example – "Fintec" |
msgID Mandatory | String Unique message identifier to identify the pacs.008 message Example – "20240531101110802BR3JqSREZueIfZx" |
paymentInfo Mandatory | Object |
endToEndId Mandatory | String ID that enables to trace the transaction at any time during the process Example – "FEDRFP20240231002" |
instructingID Mandatory (applicable only for TCH) | String Unique instructing ID of the transaction from sender Example – "2024060398989989845BTTST33219290471" |
paymentId Mandatory | String Payment reference ID of the transaction Example – "20240531101110802VZjPBb1vOg5sm8D" |
processor Mandatory | String Payment channel through which the transaction happens Example – "FEDNOW" |
rawMessage Mandatory | String Raw response message related to the transaction encoded in Base64 Example – "Base64 encoded data for received xml message" |
referenceNumber Mandatory | String Reference number of the transaction Example – "FEDRFP20240231002" |
status Mandatory | String Status of the RFP response Possible Values: RCVD – Request received by the debtor PRES – Payment presented by the debtor ACTC – Payment request accepted by the debtor RJCT – Payment request rejected Example – "ACTC" |
uuid Mandatory | String Unique ID present in the message Example – "e3fb8402-502e-433d-9094-8187f7b70ca2" |
Request Body (Applicable for both FedNow and TCH)
{
"acceptedAmount": { //applicable only for FedNow
"amount": 222200,
"currency": "USD"
},
"creditorAccount": {
"accountNumber": "69988022968",
"memberId": "101110802",
"name": "William"
},
"debtorAccount": {
"accountNumber": "200105743028554",
"memberId": "101115315",
"name": "Fintec"
},
"msgID": "20240531101110802BR3JqSREZueIfZx",
"paymentInfo": {
"endToEndID": "FEDRFP20240231002",
"instructingId": "2024060398989989845BTTST33219290471", //applicable only for TCH
"paymentId": "20240531101110802VZjPBb1vOg5sm8D"
},
"processor": "FEDNOW",
"rawMessage": "Base64 encoded data for received xml message",
"referenceNumber": "FEDRFP20240231002",
"status": "ACTC",
"uuid": "e3fb8402-502e-433d-9094-8187f7b70ca2"
}
Response
Response Parameters
Parameter | Description |
---|---|
referenceNumber | String Reference number of the RFP transaction response Example – "FEDRFP20240231002" |
status | String Status of the RFP response Example – "Accepted" |
Response Body (Applicable for both FedNow and TCH)
{
"referenceNumber": "FEDRFP20240231002",
"status": "Accepted"
}